Using SDKs

Pyramid's exposes APIs via client SDK's for certain languages as of API version 3. These are veneer libraries for Pyramid's REST API framework - which are built using the Swagger OpenAPI standard.

The SDKs are currently provided in JAVA, C#, JavaScript / TypeScript, Python and PHP. Details of how to deploy the libraries is covered below.

SDK's

All SDK libraries are NOT currently deployed to public repositories. These will be added in the future. For now, the client SDK libraries can be downloaded from the customer portal instead.

The methods below are the primary ways to include downloaded client libraries into projects for the specified programming languages, utilizing each language's standard practices and dependency management tools where available.

JAVA:

Manual JAR Import:

  • Download the JAR file for the Java SDK.
  • In the Java project, add the downloaded JAR file to the project's build path.
  • Use the necessary import statements to include classes and functionalities from the SDK in your Java code.

Local Maven Repository:

  • Create a local Maven repository or use an existing one.
  • Place the downloaded JAR file of the Java SDK into this repository.
  • Update the Maven project's pom.xml file to include the local repository path and the dependency information for the SDK.
  • Maven will then be able to resolve and fetch the SDK from the local repository during the build process

C#:

Local NuGet Server:

  • Set up a local NuGet server (such as NuGet.Server or ProGet) if one doesn't already exist.
  • Upload the downloaded DLL file(s) of the C# SDK to this local NuGet server.
  • Configure the Visual Studio project to reference this local NuGet server as a package source.
  • Install the SDK into the project using the NuGet Package Manager, pointing it to the local server.

Manual DLL Reference:

  • Download the DLL file(s) for the C# SDK.
  • In Visual Studio, add a reference to the downloaded DLL file(s) in the project settings.
  • Utilize the functionalities provided by the SDK in your C# code.

Python:

Local PyPI Repository:

  • Establish a local PyPI repository using tools like devpi or bandersnatch.
  • Upload the downloaded Python SDK package to this local PyPI repository.
  • Configure pip to use this local repository as an additional source.
  • Install the SDK into the Python project using pip, specifying the local repository as the source.

Manual Installation:

  • If the SDK package is not available via pip, it might be necessary to install it manually.
  • This could involve extracting the downloaded package and using setup scripts or copying necessary files into the Python project's directory structure.
  • Import the SDK modules / functions into your Python code after installation.

PHP:

Local Composer Repository:

  • Create a local Composer repository using tools like Satis or Toran Proxy.
  • Upload the PHP SDK files to this local Composer repository.
  • Configure Composer to use this repository as a package source.
  • Include the SDK in the PHP project using Composer, referencing the local repository.

Manual Inclusion:

  • Download the PHP SDK files and manually include them in your PHP project.
  • Ensure that you include the necessary SDK files (e.g., classes, functions) into your PHP scripts where required.

JavaScript / TypeScript:

Local npm Registry:

  • Set up a local npm registry such as Verdaccio or Sinopia.
  • Publish the JavaScript / TypeScript SDK package to this local registry.
  • Configure npm to point to this local registry as a source.
  • Install the SDK into the project using npm, referencing the local registry as the source.

Manual Inclusion (Browser Environment):

  • Download the SDK files (typically provided as JavaScript files).
  • Include these files using script tags in your HTML document where your JavaScript code is implemented.
  • Access and utilize the SDK functionalities in your JavaScript code after including the necessary files.